Appendix B: XML Project Item Configuration and Compatibility

This section details all project item types that can be added to an XF Project file and the capabilities and compatibility details that apply to each type.

The following table defines the columns and values used in the compatibility table:

Column Description
Item Type The OneStream content the project item represents.
Workspace

Whether the item belongs to a Workspace.

  • Required: A Workspace must be selected.

  • Optional: The item can be at the application level or inside a Workspace. If the Workspace property is left blank, the item is defined at the application level (Default Workspace).

  • Not Used: The item is not inside a Workspace. Any Workspace value is ignored.

Include Descendants

Whether the Include Descendants property affects what is loaded/extracted for the item.

  • Yes: This is a container. Selecting True includes the items nested beneath it.

  • No: This is a single item. The property has no effect.

  • Always: The item's child files load regardless of the property setting.
Pick From List

Whether Developer Studio can display a list of names to pick from for the selected item type.

  • Yes: You can choose a value from the drop-down menu.

  • No: You must enter the name manually.
Property Requires

The minimum OneStream platform version required for the property to display a drop-down menu of item names.

  • X: No version requirement for this item type.

  • Platform Version 9.4.0 or later: The property is only available for Platform Version 9.4.0 or later. On earlier platform versions, you must enter the name manually.
Notes End-user details

The following table outlines configuration and compatibility details:

Item Type Workspace Include Descendants Pick From List Property Requires Notes
Business rule Not used No Yes X A single rule. Selectable by rule type and name.
Cube Not used No Yes X A single cube (metadata).
Cube View group Optional Yes No X A container. Setting Includes Descendants to True adds all Cube Views in the group. Enter the name manually.
Cube View Optional No No X A single Cube View. Enter the name manually.
Cube View profile Not used No Yes X Always application-level and is not tied to a Workspace.
Dashboard Workspace Required Yes Yes X A container. Setting Includes Descendants to True adds all its maintenance units and their contents.
Dashboard maintenance unit Required Yes Yes X A container inside a Workspace. Setting Includes Descendants to True adds the maintenance unit's content.
Dashboard file Required No No X A single file within a Workspace/maintenance unit. Enter the name manually.
Dashboard string Required No No X A single string item within a Workspace/maintenance unit. Enter the name manually.
Dashboard parameter Required No No X A single item within a Workspace/maintenance unit. Enter the name manually.
Dashboard group Required Yes No X A container. Setting Includes Descendants to True adds the child dashboards. Enter the name manually.
Dashboard adapter Required No No X A single item within a Workspace/maintenance unit. Enter the name manually.
Dashboard component Required No No X A single item within a Workspace/maintenance unit. Enter the name manually.
Dashboard Required No No X A single dashboard within a Workspace/maintenance unit/dashboard group. Enter the name manually.
Workspace assembly Required Always Yes X This is Workspace-scoped. The assembly's child files always load and extract regardless of what the Include Descendants property is set to.
Dashboard profile Not used No Yes Platform Version 9.4.0 or later This is application-level, not Workspace-scoped. The Name drop-down menu requires Platform Version 9.4.0 or later to display values.
Data management group Optional Yes No X A container. Setting the Includes Descendants setting to True adds the item's steps/sequences. Enter the name manually.
Data management step Optional No No X

A single step. Steps are unique only within their data management group, so standalone selection is limited. Enter the name manually.

CAUTION: If you attempt to extract a data management step without its parent group or sequence, the extract will fail.

Data management sequence Optional No No X A single sequence. Enter the name manually.
Data source Not used No Yes Platform Version 9.4.0 or later A single data source. This is not Workspace-scoped. The Name drop-down menu requires Platform Version 9.4.0 or later to display values.
Dimension Not used No Yes X A single dimension (metadata).
Transformation rule group Not used No Yes Platform Version 9.4.0 or later A single item. This is not Workspace-scoped. This item type has no XF Project descendants. The Name drop-down menu requires Platform Version 9.4.0 or later to display values.
Transformation rule profile Not used No Yes Platform Version 9.4.0 or later A single item. This is not Workspace-scoped. The Name drop-down menu requires Platform Version 9.4.0 or later to display values.
Task Scheduler Not used No No X A single item. This is not Workspace-scoped. Enter the name manually.

NOTE: The same name can exist at the application level and inside one or more Workspaces at the same time. When that occurs, the Workspace is what distinguishes them.